docs: merge overview pages #732
Conversation
fix capitalization of Actor changes to formatting streamlining prose
TC-MO
added
documentation
Codecov Report✅ All modified and coverable lines are covered by tests.
Additional details and impacted files@@ Coverage Diff @@
## master #732 +/- ##
===========================================
- Coverage 81.98% 67.84% -14.14%
===========================================
Files 46 46
Lines 2681 2681
===========================================
- Hits 2198 1819 -379
- Misses 483 862 +379
Flags with carried forward coverage won't be shown. Click here to find out more. ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
| @@ -0,0 +1,163 @@ | |||
| --- | |||
There was a problem hiding this comment.
General note:
Is it possible to move the overview page one level up, so that it is not in the Overview section? It's kinda weird UX-wise.
There was a problem hiding this comment.
Yeah I was afraid that might happen. I think if we rename it to index.md it should not be separate openable section
| <Tabs> | ||
| <TabItem value="main.py" label="main.py" default> | ||
| <CodeBlock language="python">{ | ||
| `from apify import Actor | ||
| ${''} | ||
| async def main(): | ||
| async with Actor: | ||
| Actor.log.info('Actor input:', await Actor.get_input()) | ||
| await Actor.set_value('OUTPUT', 'Hello, world!')` | ||
| }</CodeBlock> | ||
| </TabItem> | ||
| <TabItem value="__main__.py" label="__main.py__"> | ||
| <CodeBlock language="python">{ | ||
| `import asyncio | ||
| import logging | ||
| ${''} | ||
| from apify.log import ActorLogFormatter | ||
| ${''} | ||
| from .main import main | ||
| ${''} | ||
| handler = logging.StreamHandler() | ||
| handler.setFormatter(ActorLogFormatter()) | ||
| ${''} | ||
| apify_logger = logging.getLogger('apify') | ||
| apify_logger.setLevel(logging.DEBUG) | ||
| apify_logger.addHandler(handler) | ||
| ${''} | ||
| asyncio.run(main())` | ||
| }</CodeBlock> | ||
| </TabItem> | ||
| </Tabs> |
There was a problem hiding this comment.
Consider adding some code comments?
|
|
||
| ### Creating Actors | ||
|
|
||
| To create and run Actors through Apify Console, refer to the [Console documentation](https://docs.apify.com/academy/getting-started/creating-actors#choose-your-template). |
There was a problem hiding this comment.
"through Apify Console"
Is through used in this context? I'd rather just use "in".
| To create and run Actors through Apify Console, refer to the [Console documentation](https://docs.apify.com/academy/getting-started/creating-actors#choose-your-template). | |
| To create and run Actors in Apify Console, refer to the [Console documentation](https://docs.apify.com/academy/getting-started/creating-actors#choose-your-template). |
|
|
||
| ## Requirements | ||
|
|
||
| The Apify SDK requires Python version 3.8 or above to run Python Actors locally. |
There was a problem hiding this comment.
The docs previously said that the required version is 3.10 or above. Is this updated version correct?
There was a problem hiding this comment.
Good point, I'll reach out and confirm the required version as client & sdk diverge here
|
|
||
| ## Adding dependencies | ||
|
|
||
| First, add them in the [`requirements.txt`](https://pip.pypa.io/en/stable/reference/requirements-file-format/) file in the Actor source folder. |
There was a problem hiding this comment.
| First, add them in the [`requirements.txt`](https://pip.pypa.io/en/stable/reference/requirements-file-format/) file in the Actor source folder. | |
| First, add the dependencies in the [`requirements.txt`](https://pip.pypa.io/en/stable/reference/requirements-file-format/) file in the Actor source folder. |
| </TabItem> | ||
| </Tabs> | ||
|
|
||
| Then install the dependencies: |
There was a problem hiding this comment.
| Then install the dependencies: | |
| Finally, install the dependencies: |
vdusek
left a comment
vdusek
left a comment
There was a problem hiding this comment.
When running it locally, clicking "Docs" or "Get Started" redirects to
http://localhost:3000/sdk/python/docs/overview/introduction, which results in a 404.
|
Thanks @vdusek the landing pages will removed shortly (That is why we are doing this consolidation) but I changed the links so they work properly just in case. Secondary nav has been fixed as well |
rename consolidated page to index.mdx fix left side sidebar so it doesn't have 1 item in overview category, rather that overview is clickable page itself fix top side nav so Docs send to the new page fix link on landing page
No description provided.